home *** CD-ROM | disk | FTP | other *** search
/ FishMarket 1.0 / FishMarket v1.0.iso / fishies / 501-525 / disk_502 / trackdos / trackdos.doc < prev    next >
Text File  |  1992-05-06  |  12KB  |  319 lines
  1.  
  2.             TRACKDOS V1.08 by Nic Wilson 
  3.             ----------------------------
  4.             
  5. This program is copyright Nic Wilson Software and MAY NOT be freely
  6. distributed without the written permission of Nic Wilson Software.  
  7.  
  8. It may not be used for any commercial construction or transferral 
  9. of data without written permission of Nic Wilson Software.
  10.  
  11. To obtain permission write to the address at the end of this file.
  12.             
  13. TrackDos is a program that allows easy transfer of data between the 
  14. three main areas on an Amiga.  DOS, Memory and trackdisk.device.            
  15.  
  16. DOS means the data contained within a file, Memory means the data
  17. contained anywhere within the memory map and trackdisk.device means
  18. data stored on a disk not accessable with DOS (eg. bootblocks special
  19. loader disks etc.).  The transfer of data between these three areas
  20. is not normally easy or convenient.  TrackDos was written to overcome
  21. this.
  22.  
  23. Once the program loads you will see a credits window and a prompt to
  24. click the mouse button.  This will take you to the main menu, which is
  25. a set of eight gadgets as shown below.
  26.  
  27.     Trackdisk to DOS
  28.     DOS to Trackdisk
  29.     Memory to DOS
  30.     Memory to Trackdisk
  31.     DOS to Memory
  32.     Trackdisk to Memory
  33.     Format Tracks
  34.     String Search
  35.  
  36.  
  37.  
  38.  
  39.  
  40.  
  41.  
  42. PROGRAM SUMMARY
  43. ---------------    
  44. The above are the main functions of TrackDos.  When any one of the gadgets
  45. is clicked on, another window will open for that particular function and
  46. will prompt via string gadgets for inputs.  At the bottom of each window
  47. you will notice two gadgets 'OK' and 'EXIT'.  The 'OK' gadget
  48. will attempt to perform the function and 'EXIT' will return to the main
  49. menu.  
  50.  
  51. There is one exception to the above, that is, in the Format Tracks
  52. function there is an extra gadget labeled  'INIT'  this gadget performs
  53. a quick format the same as the DOS 1.3 'QUICK' parameter of the format 
  54. command.  This will of course blank any disk and all files will be lost.  
  55. The INIT gadget only looks for the device and ignores the start and end 
  56. track string gadgets.  If a disk is accidentally 'INITted' then the
  57. diskdoctor command will rectify this as the INIT function only rewrites
  58. the Root block and the Bootblock of a disk to make it appear blank. 
  59.  
  60. Errors or prompts will be shown in the rectangular box at the
  61. extreme bottom of each window.  Once the function has been performed the 
  62. program will stay within that function incase another is required. If not
  63. then 'EXIT' can be clicked.  Every function only supports disk data in
  64. the normal range of sectors 0 to 1759 or tracks 0 to 79.  Any attempt to
  65. read or write outside this area will generate an error message.  This was
  66. done as tests have shown that reading or writing to tracks 80 to 83 is
  67. only a rumour and no proof has been seen to support the conclusion that
  68. this is at all possible.  This will be changed if conclusive evidence to
  69. the contrary is supplied to me.
  70.  
  71.  
  72.  
  73.  
  74.  
  75.  
  76.  
  77.  
  78.  
  79.  
  80.  
  81.  
  82. FORMAT FOR INPUT OF PARAMETERS
  83. ------------------------------
  84.         All numerical inputs can be given in decimal or hexadecimal.
  85.         If you supply in hexadecimal then the number must be preceded
  86.         by a dollar sign.  This format is the same for those paramters
  87.         that have other prefixes(ie. '#' and '+').  Numbers can be input
  88.         as binary by preceding with a percent (%) but I do not forsee
  89.         this being used a great deal.  This was included as my ASCtoInt
  90.         macro just happens to do it anyway.
  91.         
  92.  
  93.     INPUT EXAMPLES
  94.     --------------
  95.             To input the offset 1024 in decimal  ----->  1024
  96.             To input the offset 2c00 in hex      ----->  $2C00
  97.             To input 40 (decimal) cylinders      ----->  #40 
  98.             To input A  (hex) cylinders          ----->  #$a
  99.             To input 2  (binary) cylinders       ----->  #%10  
  100.             To input root block offset (decimal) ----->  #880
  101.             To input root block offset (hex)     ----->  #$370
  102.             To input a length of 5000 (decmal)   ----->  5000
  103.             To input a length of ABCD (hex)      ----->  $ABCD
  104.             To input desintation address $20000  ----->  $20000
  105.             To input a destination as a length   ----->  +$200
  106.         To input a start cylinder of 10      ----->  10
  107.             To input drive zero as a device      ----->  DF0:
  108.         To input drive one as a device       ----->  df1:
  109.             To input an example path/file        ----->  DH0:c/name 
  110.     
  111.         NOTE:  The above examples show upper case characters, but
  112.                either upper or lower or both is allowed.        
  113.             
  114.             
  115. WRITING BOOTBLOCKS
  116. ------------------
  117.     Any data written to the first two sectors of a disk will
  118.     be automatically checksumed, and in this current version
  119.     this cannot be disabled. 
  120.  
  121.  
  122. WRITE ERROR HANDLING
  123. --------------------
  124.        When any of the trackdisk.device write functions encounter a
  125.        hard error on the destination disk, the offending areas will
  126.        be formatted, one attempt to rewrite the data will be performed.
  127.        Failure or any other trackdisk error will cause the particular 
  128.       function to be aborted and a trackdisk error message displayed.
  129.        
  130. INPUT PARAMETERS
  131. ----------------
  132.        Below is an explanation of all parameters used by the different
  133.        functions.  Each function will use some of the following parameters.
  134.        
  135. offset        Byte sized offset to start the read from. This offset must
  136.         be block aligned else an error message will be generated.
  137.               The offset is the same as would normally be placed in the 
  138.               IO_OFFSET field of an IO_REQUEST block to perform a CMD_READ
  139.               or CMD_WRITE through trackdisk.device.  This field can also
  140.               be entered as a block number instead of an offset if so 
  141.               desired.  To enter as a block the number must be preceded 
  142.               with a hash sign (#).  
  143.               Note that the prefix for hex or decimal still applies
  144.               as shown in the examples.  Once the 'OK' gadget has been 
  145.         clicked the block number in the string gadget will be 
  146.         replaced with the calculated byte sized offset for your 
  147.         reference.  If this field is set to -1 then the offset will 
  148.         be zero and full disk of 1760 blocks will be used.  
  149.            
  150. length        Byte sized length to read/write.  Must be increments of 512 
  151.         and the minimum allowed is 1 sector.  If a number is supplied 
  152.         incorrectly is will be rounded up to the nearest sector. If
  153.         this length parameter is in a trackdisk reading function,
  154.         (ie. Trackdisk to DOS or Trackdisk to memory) it can be input
  155.         as a cylinder length (ie. number of cylinders to read) by 
  156.         inserting a prefix character hash (#) before the cylinder 
  157.         value.  When the 'OK' gadget is clicked the string gadget
  158.         will be replaced with the calculated byte sized length for
  159.         your reference.   
  160.  
  161. path/file     Path and filename.  Data will be read from, or written to 
  162.         this place and name.  It can be any valid path and name that 
  163.         you can normally use in CLI.
  164.        
  165. device      The device that the data is to be read from or written to. 
  166.         This device must be a floppy device from DF0 - DF3,
  167.         and entered as the full device string (eg. DF0:).  Full
  168.         error checking for invalid or illegal devices is performed,
  169.         so it will not accidentally try to write to your hard disk.
  170.         
  171. buffoff        Byte sized value into the file to start the write from.  
  172.         This allows you to skip over an amount at the beginning of
  173.         a file and only write out the remainder.  Very useful for 
  174.         skipping over the file header of an executable file.
  175.  
  176. source address    Memory address to start the write from.  This area can
  177.         be Fast memory or Chip memory.  This source address is
  178.         inclusive.
  179.  
  180. end address    Last memory address to write. This end memory address
  181.         is inclusive.  This parameter can be input as a length
  182.         instead of a destination address by inserting a prefix
  183.         character plus(+), before the length.  the length of
  184.         course can still be in decimal or hex as long as the
  185.         format is followed as shown in the examples. When the 'OK' 
  186.         gadget is clicked the string gadget will be changed to 
  187.         display the calculated end address for your reference.            
  188.           
  189. preferred area Your preferred area that you would like the data
  190.         placed.  If this is left blank the area will be
  191.         chosen for you and the result address will be
  192.         displayed in the box at the bottom of the window.  
  193.         If your preferred area is not available then an 
  194.         error msg will be generated and displayed in the
  195.         same box.  This memory area will only remain allocated
  196.         while the program is running and will be freed up when
  197.         you exit the program completely.  Trackdos when loaded
  198.         will spawn its own process and return the command line 
  199.         for you so you can launch another program to examine or 
  200.         modify the memory without needing another CLI window open. 
  201.  
  202. start track    This parameter is only found in Format Tracks.  It
  203.         is the starting track for the format.  Note that this
  204.         does not mean cylinder.  Amiga drives have a total
  205.         of 160 tracks, starting at 0 and ending at 159.  
  206.         (eg.Cylinder zero holds tracks 0 and 1, cylinder one 
  207.         holds tracks 2 and 3 and so on).  This track parameter 
  208.         is inclusive to the format        
  209.  
  210. end track    As above except that this is the last track to format.
  211.         This track is inclusive to the format.  Maximum number
  212.         for this parameter is of course 159.
  213.  
  214.  
  215. FUNCTIONS
  216. ---------
  217.  
  218.     Trackdisk to DOS
  219.     ----------------
  220.     FUNCTION    Transfer data from disk sectors to a file.
  221.  
  222.     PARAMETERS    offset, length, path/file, device. 
  223.  
  224.     
  225.     DOS to Trackdisk
  226.     ----------------
  227.  
  228.     FUNCTION    Transfer data from a file to disk sectors.
  229.  
  230.     PARAMETERS    offset, buffoff, length, path/file, device
  231.  
  232.  
  233.     Memory to DOS
  234.     -------------
  235.  
  236.     FUNCTION     Transfer data from memory to a file.
  237.  
  238.     PARAMETERS    source address, end address, path/file
  239.  
  240.  
  241.  
  242.     Memory to Trackdisk
  243.     -------------------
  244.                  
  245.     FUNCTION    Transfer data from memory to disk sectors
  246.  
  247.     PARAMETERS    source address, end address, offset, device
  248.  
  249.  
  250.     DOS to Memory
  251.     -------------
  252.  
  253.     FUNCTION    Transfer data from a file to memory
  254.  
  255.     PARAMETERS    length, preferred area, path/file
  256.  
  257.  
  258.     Trackdisk to Memory
  259.     -------------------
  260.  
  261.     FUNCTION    Transfer data from disk sectors to memory
  262.  
  263.     PARAMETERS    offset, length, preferred area, device
  264.  
  265.     Format Tracks
  266.     -------------
  267.     
  268.     FUNCTION  To format one or more tracks and optionally 
  269.                   initialise the disk.  Note that if a disk
  270.                   is initialised then the disk will be blanked
  271.                   and any DOS files that were on the disk
  272.                   will disappear.  To format a single track
  273.                   put the same number in start and end tracks.
  274.                   (ie. to format track 90 put that number in
  275.                   both start and end).  The disk will NOT BE
  276.                   initialised via the 'OK' gadget.  If you
  277.                   require the disk to be initialised then the
  278.                   'INIT' gadget must be clicked after the 
  279.                   formatting has finished. 
  280.  
  281.     PARAMETERS    start track, end track, device
  282.  
  283.     INIT       This gadget will initialise or quick format
  284.           a disk in the drive specified by the device
  285.           string gadget.  The disk of course must be
  286.           already formatted.  
  287.             
  288.         
  289.     String Search
  290.     -------------
  291.     FUNCTION  To search for a particular string in memory.
  292.           Many users have requested this function so
  293.           that they can easily find a lost document in
  294.           memory and then save it to a file using one
  295.           of the other functions.  When OK is clicked
  296.           the string will be searched for and if found
  297.           the Start string will be updated to start at
  298.           the next address after the find, so that if
  299.           the one it found is not the correct one you
  300.           can just click OK again to continue the search.
  301.           This allows you to write down every possibility
  302.            and save a range of memory locations.
  303.  
  304.     PARAMETERS    start address, end address, string
  305.  
  306.     
  307. Any questions, bugs, suggestion or spare money,
  308.  
  309. send or write to
  310.  
  311. Nic Wilson
  312. Nic Wilson Software
  313. 138d South Street
  314. Toowoomba Queensland 4350
  315. ph (076) 358522 work & fax
  316.    (076) 358539 home
  317.            
  318.  
  319.